Open topic with navigation

SW Programming: Keysight SD1 Programming Libraries

SW Programming Overview

As described in Keysight SD1 Programming Libraries, Keysight provides highly-optimized programming librariesin the most common programming languages:

A. Native Languages

Ready-to-use native libraries are supplied for the following programming languages and compilers:

B. Other Languages

Dynamic-link libraries are compatible with any programming language that has a compiler capable of performing dynamic linking. Here are some case examples:

• Compilers not listed above.

• Other programming languages: Java, PHP, Perl, Fortran, Pascal, etc.

• Computer Algebra Systems (CAS): Wolfram Mathematica, Maplesoft Maple, etc. Dynamic-link libraries available:

Exported Functions LanguageOperating SystemFiles

CMicrosoft Windows*.dll

SD_Module Functions

open

This function initializes a hardware module therefore it must be called before using any other module-related function. A module can be opened using the serial number or the chassis and slot number. The first option ensures the same module is always opened regardless its chassis or slot location.

Parameters

C

int SD_Module_openWithSerialNumber(const char* productName, const char* serialNumber);

int SD_Module_openWithSlot(const char* productName, int chassis, int slot);

int SD_Module_openWithSerialNumberCompatibility(const char* productName, const char* serialNumber, int compatibility);

int SD_Module_openWithSlotCompatibility(const char* productName, int chassis, int slot, int compatibility);

C++

int SD_Module::open(const char* productName, const char* serialNumber);

int SD_Module::open(const char* productName, int chassis, int slot);

int SD_Module::open(const char* productName, const char* serialNumber, int compatibility);

int SD_Module::open(const char* productName, int chassis, int slot, int compatibility);

Visual Studio .NET, MATLAB

int SD_Module::open(string productName, string serialNumber);

int SD_Module::open(string productName, int chassis, int slot);

int SD_Module::open(string productName, string serialNumber, int compatibility);

int SD_ Module::open(string productName, int chassis, int slot, int compatibility);

Python

int SD_Module::openWithSerialNumber(string productName, string serialNumber);

int SD_Module::openWithSlot(string productName, int chassis, int slot);

int SD_Module::openWithSerialNumberCompatibility(string productName, string serialNumber, int compatibility);

int SD_ Module::openWithSlotCompatibility(string productName, int chassis, int slot, int compatibility);

LabVIEW

open.vi

M3601A

Available: No

close

This function releases all the resources allocated for the module instance. It must be always called before exiting the application.

Parameters

C

int SD_Module_close(int moduleID);

C++

int SD_Module::close();

Visual Studio .NET, MATLAB

int SD_Module::close();

Python

int SD_Module::close();

LabVIEW

close.vi

M3601A

Available: No

moduleCount

This function returns the number of Keysight modules installed in the system.

Parameters

C

int SD_Module_moduleCount();

C++

int SD_Module::moduleCount();

Visual Studio .NET, MATLAB

int SD_Module::moduleCount();

Python

int SD_Module::moduleCount();

LabVIEW

moduleCount.vi

M3601A

Available: No

getProductName

This function returns the product name of the specified device.

Parameters

C

int SD_Module_getProductNameByIndex(int index, char *productName);

int SD_Module_getProductNameBySlot(int chassis, int slot, char* productName);

C++

int SD_Module::getProductName(int index, char *productName);

int SD_Module::getProductName(int chassis, int slot, char* productName);

Visual Studio .NET, MATLAB

int SD_Module::getProductName(int index, string productName);

int SD_Module::getProductName(int chassis, int slot, string productName);

Python

int SD_Module::getProductNameByIndex(int index, string productName);

int SD_Module::getProductNameBySlot(int chassis, int slot, string productName);

LabVIEW

getProductNameByIndex.vi

getProductNameBySlot.vi

M3601A

Available: No

getSerialNumber

This function returns the serial number of the specified device.

Parameters

C

int SD_Module_getSerialNumberByIndex(int index, char *serialNumber);

int SD_Module_getSerialNumberBySlot(int chassis, int slot, char* serialNumber);

C++

int SD_Module::getSerialNumber(int index, char *serialNumber);

int SD_Module::getSerialNumber(int chassis, int slot, char* serialNumber);

Visual Studio .NET, MATLAB

int SD_Module::getSerialNumber(int index, char *serialNumber);

int SD_Module::getSerialNumber(int chassis, int slot, char* serialNumber);

Python

int SD_Module::getSerialNumberByIndex(int index, char *serialNumber);

int SD_Module::getSerialNumberBySlot(int chassis, int slot, char* serialNumber);

LabVIEW

getSerialNumberByIndex.vi

getSerialNumberBySlot.vi

M3601A

Available: No

getChassis

This function returns the chassis number where the device is located.

Parameters

C

int SD_Module_getChassis(int index);

C++

int SD_Module::getChassis(int index);

Visual Studio .NET, MATLAB

int SD_Module::getChassis(int index);

Python

int SD_Module::getChassis(int index);

LabVIEW

getChassis.vi

M3601A

Available: No

getSlot

This function returns the slot number where the device is located.

Parameters

C

int SD_Module_getSlot(int index);

C++

int SD_Module::getSlot(int index);

Visual Studio .NET, MATLAB

int SD_Module::getSlot(int index);

Python

int SD_Module::getSlot(int index);

LabVIEW

getSlot.vi

M3601A

Available: No

PXItriggerWrite

This function sets the digital value of a PXI trigger in the PXI backplane. This function is only available in PXI / PXI Express form factors.

Parameters

C

int SD_Module_PXItriggerWrite(int moduleID, int nPXItrigger, int value);

C++

int SD_Module::PXItriggerWrite(int nPXItrigger, int value);

Visual Studio .NET, MATLAB

int SD_Module::PXItriggerWrite(int nPXItrigger, int value);

Python

int SD_Module::PXItriggerWrite(int nPXItrigger, int value);

LabVIEW

PXItriggerWrite.vi

M3601A

Available: Yes

PXItriggerRead

This function reads the digital value of a PXI trigger in the PXI backplane. This function is only available in PXI / PXI Express form factors.

Parameters

C

int SD_Module_PXItriggerRead(int moduleID, int nPXItrigger);

C++

int SD_Module::PXItriggerRead(int nPXItrigger);

Visual Studio .NET, MATLAB

int SD_Module::PXItriggerRead(int nPXItrigger);

Python

int SD_Module::PXItriggerRead(int nPXItrigger);

LabVIEW

PXItriggerRead.vi

M3601A

Available: No (the value can be accessed using math operations: e.g. MathAssign)

SD_Module Functions (FPGA-related)

The following programming functions are related to Keysight’s FPGA technology and Keysight M3602A programming environment. Please check the Keysight M3602A datasheet for more information [1].

FPGAwritePCport

This function writes data at the PCport FPGA Block.

Parameters

C

int SD_Module_FPGAwritePCport(int moduleID, int nPCport, long* data, int dataSize, int address, int addressMode, int accessMode);

C++

int SD_Module::FPGAwritePCport(int nPCport, int* data, int dataSize, int address, SD_AddressingMode addressMode, SD_AccessMode accessMode);

Visual Studio .NET, MATLAB

int SD_Module::FPGAwritePCport(int nPCport, int [] data, int address, SD_AddressingMode addressMode, SD_AccessMode accessMode);

Python

int SD_Module::FPGAwritePCport(int nPCport, int [] data, int address, int addressMode, int accessMode);

LabVIEW

PCportWrite.vi

M3601A

Available: No

FPGAreadPCport

This function reads data at the PCport FPGA Block.

Parameters

C

int SD_Module_FPGAreadPCport(int moduleID, int nPCport, int* data, int dataSize, int address, int addressMode, int accessMode);

C++

int SD_Module::FPGAreadPCport(int nPCport, int* data, int dataSize, int address, SD_AddressingMode addressMode, SD_AccessMode accessMode);

Visual Studio .NET, MATLAB

int SD_Module::FPGAreadPCport(int nPCport, int address, int[] data, SD_AddressingMode addressMode, SD_AccessMode accessMode);

Python

{int[], int} SD_Module::FPGAreadPCport(int nPCport, int dataSize, int address, int addressMode, int accessMode);

*Returned data array is a NumPy array

LabVIEW

FPGAwritePCport.vi

M3601A

Available: No

SD Module Functions (HVI-related)

The following programming functions are related to Keysight's HVI technology and Keysight M3601A Design Environment. Please, check M3601A User Guide for more information.

writeRegister

This function writes a value in an HVI register of a hardware module.

Parameters

C

int SD_Module_writeRegister(int moduleID, int regNumber, int regValue);

int SD_Module_writeRegisterWithName(int moduleID, const char* regName, int regValue);

int SD_Module_writeDoubleRegister(int moduleID, int regNumber, double regValue, const char* unit);

int SD_Module_writeDoubleRegisterWithName(int moduleID, const char* regName, double regValue, const char* unit);

C++

int SD_Module::writeRegister(int regNumber, int regValue);

int SD_Module::writeRegister(const char* regName, int regValue);

int SD_Module::writeRegister(int regNumber, double regValue, const char* unit);

int SD_Module::writeRegister(const char* regName, double regValue, const char* unit);

Visual Studio .NET, MATLAB

int SD_Module::writeRegister(int regNumber, int regValue);

int SD_Module::writeRegister(string regName, int regValue);

int SD_Module::writeRegister(int regNumber, double regValue, string unit);

int SD_Module::writeRegister(string regName, double regValue, string unit);

Python

int SD_Module::writeRegisterByNumber(int regNumber, int regValue);

int SD_Module::writeRegisterWithName(string regName, int regValue);

int SD_Module::writeDoubleRegisterByNumber(int regNumber, double regValue, string unit);

int SD_Module::writeDoubleRegisterWithName(string regName, double regValue, string unit);

LabVIEW

writeRegister.vi

M3601A

Available: No (the value can be accessed using math operations: e.g. MathAssign)

readRegister

This function reads a value from an HVI register of a hardware module.

Parameters

C

int SD_Module_readRegister(int moduleID, int regNumber, int regValue);

int SD_Module_readRegisterWithName(int moduleID, const char* regName, int regValue);

double SD_Module_readDoubleRegister(int moduleID, int regNumber, const char* unit, int& errorOut);

double SD_Module_readDoubleRegisterWithName(int moduleID, const char* regName, const char* unit, int& errorOut);

C++

int SD_ Module::readRegister(int regNumber, int regValue);

int SD_ Module::readRegister(const char* regName, int regValue);

double SD_ Module::readRegister(int regNumber, const char* unit, int& errorOut);

double SD_ Module::readRegister(const char* regName, const char* unit, int& errorOut);

Visual Studio .NET, MATLAB

int SD_ Module::readRegister(int regNumber, int regValue);

int SD_ Module::readRegister(string regName, int regValue);

int SD_ Module::readRegister(int regNumber, string unit, out int error);

int SD_ Module::readRegister(string regName, string unit, out int error);

Python

int SD_Module::readRegisterByNumber(int regNumber, int regValue);

int SD_Module::readRegisterWithName(string regName, int regValue);

[int errorOut, double regValue] SD_Module::readDoubleRegisterByNumber(int regNumber, string unit;

[int errorOut, double regValue] SD_Module::readDoubleRegisterWithName(string regName, string unit);

LabVIEW

readRegister.vi

M3601A

Available: No (the value can be accessed using math operations: e.g. MathAssign)

SD_AIN Functions

channelInputConfig

This function configures the input full scale, impedance and coupling as applicable according to the product Full Scale, Impedance and Coupling.

Parameters

C

int SD_AIN_channelInputConfig(int moduleID, int nChannel, double fullScale, int coupling);

C++

int SD_AIN::channelInputConfig(int nChannel, double fullScale, int coupling);

Visual Studio .NET, MATLAB

int SD_AIN::channelInputConfig(int nChannel, double fullScale, int coupling);

Python

int SD_AIN::channelInputConfig(int nChannel, double fullScale, int coupling);

LabVIEW

channelInputConfig.vi

M3601A

Available: No

channelPrescalerConfig

This function configures the input Theory of Operation: M31/M33XX Digitizers.

Parameters

C

int SD_AIN_channelPrescalerConfig(int moduleID, int nChannel, int prescaler);

C++

int SD_AIN::channelPrescalerConfig(int nChannel, int prescaler);

Visual Studio .NET, MATLAB

int SD_AIN::channelPrescalerConfig(int nChannel, int prescaler);

Python

int SD_AIN::channelPrescalerConfig(int nChannel, int prescaler);

LabVIEW

channelPrescalerConfig.vi

M3601A

Available: Yes

channelTriggerConfig

This function configures the analog trigger block for each channel Analog Trigger.

Parameters

C

int SD_AIN_channelTriggerConfig(int moduleID, int nChannel, int analogTriggerMode, double threshold);

C++

int SD_AIN::channelTriggerConfig(int nChannel, int analogTriggerMode, double threshold);

Visual Studio .NET, MATLAB

int SD_AIN::channelTriggerConfig(int nChannel, int analogTriggerMode, double threshold);

Python

int SD_AIN::channelTriggerConfig(int nChannel, int analogTriggerMode, double threshold);

LabVIEW

channelTriggerConfig.vi

M3601A

Available: Yes

DAQconfig

This function configures the acquisition of words Data Acquisition (DAQs) in two possible reading modes:

• Blocking: Using the function DAQread to read the words. DAQread is a blocking function that is released when the amount of words specified in DAQpoints is acquired or when timeout elapses. This mode is enabled when a callback function is not specified (it is set to null).
• Non-blocking: The user specifies a callback function which is called whenever the DAQeventDataReady event is signaled or when

timeout elapses. In the latter condition, there may be words available, but less than the amount specified in DAQpoints.

Parameters

C

int SD_AIN_DAQconfig(int moduleID, int nDAQ, int DAQpointsPerCycle, int cycles, int triggerDelay, int triggerMode);

C++

int SD_AIN::DAQconfig(int nDAQ, int DAQpointsPerCycle, int cycles, int triggerDelay, int triggerMode;

Visual Studio .NET, MATLAB

int SD_AIN::DAQconfig(int nDAQ, int DAQpointsPerCycle, int cycles, int triggerDelay, int triggerMode;

Python

int SD_AIN::DAQconfig(int nDAQ, int DAQpointsPerCycle, int cycles, int triggerDelay, int triggerMode;

LabVIEW

DAQconfig.vi

DAQdigitalTriggerConfig

This function configures the digital hardware triggers for the selected DAQ Trigger.

Parameters

C

int SD_AIN_DAQdigitalTriggerConfig(int moduleID, int nDAQ, int triggerSource, int triggerNumber, int triggerBehaviour);

C++

int SD_AIN::DAQdigitalTriggerConfig(int nDAQ, int triggerSource, int triggerBehaviour);

Visual Studio .NET, MATLAB

int SD_AIN::DAQdigitalTriggerConfig(int nDAQ, int triggerSource, int triggerBehaviour);

Python

int SD_AIN::DAQdigitalTriggerConfig(int nDAQ, int triggerSource, int triggerBehaviour);

LabVIEW

DAQdigitalTriggerConfig.vi

M3601A

Available: Yes

DAQanalogTriggerConfig

This function configures the analog hardware trigger for the selected DAQ Trigger.

Parameters

C

int SD_AIN_DAQanalogTriggerConfig (int moduleID, int nDAQ, int triggerNumber);

C++

int SD_AIN::DAQanalogTriggerConfig (int nDAQ, int triggerNumber);

Visual Studio .NET, MATLAB

int SD_AIN::DAQanalogTriggerConfig (int nDAQ, int triggerNumber);

Python

int SD_AIN::DAQanalogTriggerConfig (int nDAQ, int triggerNumber);

LabVIEW

DAQanalogTriggerConfig .vi

M3601A

Available: No

DAQread

This function reads the words acquired with the selected DAQ Data Acquisition (DAQs). It can be used only after calling the function DAQconfig and when a callback function is not configured. DAQread is a blocking function released when the configured amount of words is acquired, or when the configured timeout elapses (if timeout is set to ”0” , then DAQreadwaits until DAQpoints are acquired). In the timeout elapses, there may be words available, but less than the configured amount.

Parameters

C

int SD_AIN_DAQread(int moduleID, int nDAQ, short* DAQdata, int DAQpoints, int timeout);

C++

int SD_AIN::DAQread(int nDAQ, short* DAQdata, int DAQpoints, int timeout);

Visual Studio .NET, MATLAB

int SD_AIN::DAQread(int nDAQ, short[] DAQdata, int timeout);

Python

{short[], int} SD_AIN::DAQread(int nDAQ, int DAQpoints, int timeout);

*Returned data array is a NumPy array

LabVIEW

DAQread.vi

M3601A

Available: No

DAQstart

This function starts acquisition on the selected DAQs Data Acquisition (DAQs). Acquisition will start when a trigger is received.

Parameters

C

int SD_AIN_DAQstart(int moduleID, int nDAQ);

C++

int SD_AIN::DAQstart(int nDAQ);

Visual Studio .NET, MATLAB

int SD_AIN::DAQstart(int nDAQ);

Python

int SD_AIN::DAQstart(int nDAQ);

LabVIEW

DAQstart.vi

M3601A

Available: Yes

DAQstartMultiple

This function starts acquisition on the selected DAQs Data Acquisition (DAQs). Acquisition will start when a trigger is received.

Parameters

C

int SD_AIN_DAQstartMultiple(int moduleID, int DAQmask);

C++

int SD_AIN::DAQstartMultiple(int DAQmask);

Visual Studio .NET, MATLAB

int SD_AIN::DAQstartMultiple(int nDAQmask);

Python

int SD_AIN::DAQstartMultiple(int nDAQmask);

LabVIEW

DAQstartMultiple.vi

M3601A

Available: No (multiple DAQstart from different channels can be executed at once)

DAQstop

This function stops the words acquisition Data Acquisition (DAQs).

Parameters

C

int SD_AIN_DAQstop(int moduleID, int nDAQ);

C++

int SD_AIN::DAQstop(int nDAQ);

Visual Studio .NET, MATLAB

int SD_AIN::DAQstop(int nDAQ);

Python

int SD_AIN::DAQstop(int nDAQ);

LabVIEW

DAQstop.vi

M3601A

Available: Yes

DAQstopMultiple

This function pauses the words acquisition Data Acquisition (DAQs).

Parameters

C

int SD_AIN_DAQstopMultiple(int moduleID, int DAQmask);

C++

int SD_AIN::DAQstopMultiple(int DAQmask);

Visual Studio .NET, MATLAB

int SD_AIN::DAQstopMultiple(int nDAQ);

Python

int SD_AIN::DAQstopMultiple(int nDAQ);

LabVIEW

DAQstopMultiple.vi

M3601A

Available: No (multiple DAQstop from different channels can be executed at once)

DAQpause

This function pauses the words acquisition Data Acquisition (DAQs). Acquisition can be resumed using DAQresume.

Parameters

C

int SD_AIN_DAQpause(int moduleID, int nDAQ);

C++

int SD_AIN::DAQpause(int nDAQ);

Visual Studio .NET, MATLAB

int SD_AIN::DAQpause(int nDAQ);

Python

int SD_AIN::DAQpause(int nDAQ);

LabVIEW

DAQpause.vi

M3601A

Available: Yes

DAQpauseMultiple

This function pauses the words acquisition Data Acquisition (DAQs). Acquisition can be resumed using DAQresume.

Parameters

C

int SD_AIN_DAQpauseMultiple(int moduleID, int DAQmask);

C++

int SD_AIN::DAQpauseMultiple(int DAQmask);

Visual Studio .NET, MATLAB

int SD_AIN::DAQpauseMultiple(int DAQmask);

Python

int SD_AIN::DAQpauseMultiple(int DAQmask);

LabVIEW

DAQpauseMultiple.vi

M3601A

Available: No (multiple DAQpause from different channels can be executed at once)

DAQresume

This function resumes acquisition on the selected DAQs Data Acquisition (DAQs).

Parameters

C

int SD_AIN_DAQresume(int moduleID, int nDAQ);

C++

int SD_AIN::DAQresume(int nDAQ);

Visual Studio .NET, MATLAB

int SD_AIN::DAQresume(int nDAQ);

Python

int SD_AIN::DAQresume(int nDAQ);

LabVIEW

DAQresume.vi

M3601A

Available: Yes

DAQresumeMultiple

This function resumes acquisition on the selected DAQs Data Acquisition (DAQs)

Parameters

C

int SD_AIN_DAQresumeMultiple(int moduleID, int DAQmask);

C++

int SD_AIN::DAQresumeMultiple(int DAQmask);

Visual Studio .NET, MATLAB

int SD_AIN::DAQresumeMultiple(int DAQmask);

Python

int SD_AIN::DAQresumeMultiple(int DAQmask);

LabVIEW

DAQresumeMultiple.vi

M3601A

Available: No (multiple DAQresume from different channels can be executed at once)

DAQflush

This function flushes the acquisition buffers and resets the acquisition counter included in a Data Acquisition block (Data Acquisition (DAQs)).

Parameters

C

int SD_AIN_DAQflush(int moduleID, int nDAQ);

C++

int SD_AIN::DAQflush(int nDAQ);

Visual Studio .NET, MATLAB

int SD_AIN::DAQflush(int nDAQ);

Python

int SD_AIN::DAQflush(int nDAQ);

LabVIEW

DAQflush.vi

M3601A

Available: Yes

DAQflushMultiple

This function flushes the acquisition buffers and resets the acquisition counter included in a Data Acquisition block (Data Acquisition (DAQs).

Parameters

C

int SD_AIN_DAQflushMultiple(int moduleID, int DAQmask);

C++

int SD_AIN::DAQflushMultiple(int DAQmask);

Visual Studio .NET, MATLAB

int SD_AIN::DAQflushMultiple(int DAQmask);

Python

int SD_AIN::DAQflushMultiple(int DAQmask);

LabVIEW

DAQflushMultiple.vi

M3601A

Available: No (multiple DAQflush from different channels can be executed at once)

DAQtrigger

This function triggers the acquisition of words in the selected DAQs (Data Acquisition (DAQs)) provided that they are configured for VI/HVI Trigger.

Parameters

C

int SD_AIN_DAQtrigger(int moduleID, int nDAQ);

C++

int SD_AIN::DAQtrigger(int nDAQ);

Visual Studio .NET, MATLAB

int SD_AIN::DAQtrigger(int nDAQ);

Python

int SD_AIN::DAQtrigger(int nDAQ);

LabVIEW

DAQtrigger.vi

M3601A

Available: Yes

DAQtriggerMultiple

This function triggers the acquisition of words in the selected DAQs Data Acquisition (DAQs) provided that they are configured for VI/HVI Trigger.

Parameters

C

int SD_AIN_DAQtriggerMultiple(int moduleID, int DAQmask);

C++

int SD_AIN::DAQtriggerMultiple(int DAQmask);

Visual Studio .NET, MATLAB

int SD_AIN::DAQtriggerMultiple(int DAQmask);

Python

int SD_AIN::DAQtriggerMultiple(int DAQmask);

LabVIEW

DAQtriggerMultiple.vi

M3601A

Available: No (multiple DAQtrigger from different channels can be executed at once)

DAQcounterRead

This function reads the number of words acquired by the selected DAQ (Data Acquisition (DAQs)) since the last call to DAQflush or DAQ.

Parameters

C

int SD_AIN_DAQcounterRead(int moduleID, int DAQ);

C++

int SD_AIN::DAQcounterRead(int DAQ);

Visual Studio .NET, MATLAB

int SD_AIN::DAQcounterRead(int DAQ);

Python

int SD_AIN::DAQcounterRead(int DAQ);

LabVIEW

DAQcounterRead.vi

M3601A

Available: No

triggerIOconfig

This function configures the trigger connector/line direction and synchronization/sampling method (I/O Triggers).

Parameters

C

int SD_AIN_triggerIOconfig(int moduleID, int direction, int syncMode);

C++

int SD_AIN::triggerIOconfig(int direction, int syncMode);

Visual Studio .NET, MATLAB

int SD_AIN::triggerIOconfig(int direction, int syncMode);

Python

int SD_AIN::triggerIOconfig(direction);

LabVIEW

triggerIOconfig.vi

M3601A

Available: No

triggerIOwrite

This function sets the trigger output. The trigger must be configured as output using function triggerIOconfig) and I/O Triggers.

Parameters

C

int SD_AIN_triggerIOwrite(int moduleID, int value);

C++

int SD_AIN::triggerIOwrite(int value);

Visual Studio .NET, MATLAB

int SD_AIN::triggerIOwrite(int value);

Python

int SD_AIN::triggerIOwrite(int value);

LabVIEW

triggerIOwrite.vi

M3601A

Available: Yes

triggerIOread

This function reads the trigger input (I/O Triggers)

Parameters

C

int SD_AIN_triggerIOread(int moduleID);

C++

int SD_AIN::triggerIOread();

Visual Studio .NET, MATLAB

int SD_AIN::triggerIOread();

Python

int SD_AIN::triggerIOread();

LabVIEW

triggerIOread.vi

M3601A

Available: No (can be acceses usingmat operations)

clockSetFrequency

This function sets the module clock frequency, see FlexCLK Technology (models with variable sampling rate).

Parameters

*In Keysight Programming Libraries v.1.57.61 or older, clockSetFrequency returns CLKsyncFreq, the frequency of the internal CLKsync in Hz

C

double SD_AIN_clockSetFrequency(int moduleID, double frequency, int mode);

C++

double SD_AIN::clockSetFrequency(double frequency, int mode);

Visual Studio .NET, MATLAB

double SD_AIN::clockSetFrequency(double frequency, int mode);

Python

double SD_AIN::clockSetFrequency(double frequency, int mode);

LabVIEW

clockSetFrequency.vi

M3601A

Available: No

clockGetFrequency

This function returns the real hardware clock frequency (Clock System). It may differ from the frequency set with the function clockSetFrequency, due to the hardware frequency resolution.

Parameters

C

double SD_AIN_clockGetFrequency(int moduleID);

C++

double SD_AIN::clockGetFrequency();

Visual Studio .NET, MATLAB

double SD_AIN::clockGetFrequency();

Python

double SD_AIN::clockGetFrequency();

LabVIEW

clockGetFrequency.vi

M3601A

Available: No

clockGetSyncFrequency

This function returns the frequency of Clock System

Parameters

C

int SD_AIN_clockGetSyncFrequency(int moduleID);

C++

int SD_AIN::clockGetSyncFrequency();

Visual Studio .NET, MATLAB

int SD_AIN::clockGetSyncFrequency();

Python

int SD_AIN::clockGetSyncFrequency();

LabVIEW

clockGetSyncFrequency.vi

M3601A

Available: No

clockResetPhase

This function sets the module in a sync state, waiting for the first trigger to reset the phase of the internal clocks CLKsync and CLKsys (see Clock System).

Parameters

C

int SD_AIN_clockResetPhase(int moduleID, int triggerBehavior, int PXItrigger, double skew);

C++

int SD_AIN::clockResetPhase(int triggerBehavior, int PXItrigger, double skew);

Visual Studio .NET, MATLAB

int SD_AIN::clockResetPhase(int triggerBehavior, int PXItrigger, double skew);

Python

int SD_AIN::clockResetPhase(int triggerBehavior, int PXItrigger, double skew);

LabVIEW

clockResetPhase.vi

M3601A

Available: No

DAQbufferPoolConfig

This function configures buffer pool that will be filled with the data of the channel to be transferred to PC.

Parameters

C

int SD_AIN_DAQbufferPoolConfig(int moduleID, int nDAQ, short* dataBuffer, int nPoints, int timeOut, callbackEventPtr callbackFunction, void *callbackUserObj);

C++

int SD_AIN::DAQbufferPoolConfig(int nDAQ, short* dataBuffer, int nPoints, int timeOut, callbackEventPtr callbackFunction, void *callbackUserObj);

Visual Studio .NET, MATLAB

int SD_AIN::DAQbufferPoolConfig(int nDAQ, short[] dataBuffer);

Python

int SD_AIN::DAQbufferPoolConfig(int nDAQ, int nPoints, int timeOut);

LabVIEW

DAQbuffer functions are not accessible

M3601A

Available: No

DAQbufferAdd

Adds an additional buffer to the channel’s previously configured pool.

Parameters

C

int SD_AIN_DAQbufferAdd(int moduleID, int nDAQ, short* dataBuffer, int nPoints);

C++

int SD_AIN::DAQbufferAdd(int nDAQ, short *dataBuffer, int nPoints);

Visual Studio .NET, MATLAB

int SD_AIN::DAQbufferAdd(int nDAQ, short[] dataBuffer);

Python

Not available

LabVIEW

DAQbuffer functions are not accessible

M3601A

Available: No

DAQbufferGet

Gets a filled buffer from the channel buffer pool. User has to call DAQbufferAdd with this buffer to tell the pool that the buffer can be used again.

Parameters

C

short* SD_AIN_DAQbufferGet(int moduleID, int nDAQ, int &readPointsOut, int &errorOut);

C++

short* SD_AIN:: DAQbufferGet(int nDAQ, int &readPointsOut, int &errorOut);

Visual Studio .NET, MATLAB

short[] SD_AIN::DAQbufferGet(int nDAQ, out int readPointsOut, out int errorOut);

Python

[short[], int} SD_AIN::DAQbufferGet(int nDAQ);

*Returned data array is a NumPY array

LabVIEW

DAQbuffer functions are not accessible

M3601A

Available: No

DAQbufferPoolRelease

Releases the channel buffer pool and its resources. After this call, user has to call DAQbufferRemove consecutively to get all buffers back and release them.

Parameters

C

int SD_AIN_DAQbufferRelease(int moduleID, int nDAQ);

C++

int SD_AIN::DAQbufferPoolRelease(int nDAQ);

Visual Studio .NET, MATLAB

int SD_AIN::DAQbufferPoolRelease(int nDAQ);

Python

SD_AIN::DAQbufferDAQbufferPoolRelease(int nDAQ);

LabVIEW

DAQbuffer functions are not accessible

M3601A

Available: No

DAQbufferRemove

Ask for a buffer to be removed from the channel buffer pool. If NULL pointer is returned, no more buffers remains in buffer pool. Returned buffer is a previously added buffer from user and user has to release/delete it.

Parameters

C

short* SD_AIN_DAQbufferRemove(int moduleID, int nDAQ);

C++

short* SD_AIN::DAQbufferRemove(int nDAQ);

Visual Studio .NET, MATLAB

short[] SD_AIN::DAQbufferRemove(int nDAQ);

Python

Not available

LabVIEW

DAQbuffer functions are not accessible

M3601A

Available: No

FFT

Calculates the FFT of data captured by DAQread for the selected channel.

Parameters

C

int SD_AIN_FFT(int moduleID, int channel, short *data, int size, double *result, int resultSize, double *resultPhase, bool dB, int windowType);

C++

int SD_AIN::FFT(int channel, short *data, int size, double *result, int resultSize, double *resultPhase, bool dB, int windowType);

Visual Studio .NET, MATLAB

int SD_AIN::FFT(int channel, short[] data, out double[] result, bool dB, int windowType);

int SD_AIN::FFT(int channel, short[] data, out double[] result, out double[] resultPhase, bool dB, int windowType);

Python

{double[][], int} SD_AIN::FFT(int channel, short[] data, bool dB, int windowType);

*Returned data array is a NumPy array

LabVIEW

Not available

M3601A

Available: No

Error Codes

Table 15: Software error codes